/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.tool;

import axil.api.Axil;
import axil.tool.option.Option;

import java.io.PrintStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;

import static axil.framework.Functions.quote;
import static axil.framework.Functions.str;


/**
 * An abstract base class for implementing command line tools.
 */
public abstract class Tool {
	private String name;
	private Map<String,Option> options;
	private boolean quiet;


	protected Tool(String name, Map<String, Option> options) {
		this.name = name;
		this.options = options;
		this.quiet = false;
	}


	private void parse(Map<String,Option> options, String[] args) {
		final int size = args.length;
		int i = 0;
		while (i < size) {
			String arg = args[i];
			if ((arg.charAt(0) == '-') && (arg.length() > 1)) {
				Option opt = options.get(arg);
				if (opt == null) {
					abort("The sequence " + quote(arg) +
					      " is not a valid option.");
				}
				List<String> params = new ArrayList<String>();
				for (int a = 0; a < opt.args(); a++) {
					i++;
					if (i < size) {
						params.add(args[i]);
					} else {
						abort("Not enough parameters specified for " +
						      quote(arg));
					}
				}
				opt.execute(this, params);
			} else {
				arg(arg);
			}
		}
	}


	public void abort(String message) {
		System.err.println(message);
		System.exit(1);
	}


	public void exit() {
		System.exit(0);
	}


	public void print(List<String> lines) {
		for (String line : lines) {
			print(line);
		}
	}


	public void print(Object object) {
		System.out.println(str(object));
	}


	public void print() {
		System.out.println();
	}



	public Collection<Option> options() {
		return options.values();
	}


	public void quiet(boolean setting)	{
		this.quiet = setting;
	}


	/**
	 * Display a splash screen for this tool when it is run.
	 */
	public void splash(PrintStream out) {
		out.println();
		out.println(name + " - " + Axil.instance().release());
		out.println("Copyright(c) 2009-2012 Alexander Dubu");
		out.println("All rights reserved.");
		out.println();
	}


	/**
	 * Add the given string as a common line argument (not a '-' option) for
	 * this tool. This method must check the validity of the argument.
	 */
	protected abstract void arg(String arg);


	/**
	 * Execute this tool.
	 */
	protected abstract void execute();


	public final void run(String[] args) {
		parse(options, args);
		if (! quiet) {
			splash(System.out);
		}
		execute();
	}
}
